home *** CD-ROM | disk | FTP | other *** search
/ Collection of Tools & Utilities / Collection of Tools and Utilities.iso / clipper / slsw.zip / SUPER_C.FUN < prev    next >
Text File  |  1990-06-29  |  7KB  |  199 lines
  1.  
  2.   --------------C and ASM Functions-------------------
  3.    
  4.    
  5.    Below are the C and Assembler functions in the library
  6.  
  7. Function:     Aleng()
  8. Purpose :     Determines initialized length of an array
  9. Usage   :     Aleng(<array>)
  10. Params  :     <array> the array you wish to determine the length of
  11. Returns :     Length of the array
  12. Found in:     aleng.c
  13.  
  14. --------------------------------------------------------------------------
  15.  
  16. Function:     Att()
  17. Purpose :     Change attribute of area of the screen
  18. Usage   :     Att(<expN1>, <expN2>, <expN3>, <expN4>, <expN5>, [expC] )
  19. Params  :     expN1 - top row
  20.               expN2 - left col
  21.               expN3 - bottom row
  22.               expN4 - right column
  23.               expN5 - attribute to set area
  24.               expC  - character to fill area with
  25. Returns :     nothing.
  26. Found in:     att.c
  27.  
  28.  
  29. --------------------------------------------------------------------------
  30.  
  31.  * INTERNAL *
  32.  
  33. Function:     Attt()
  34. Purpose :     Used by C functions to color a screen area
  35. Usage   :     See relevent C functions. To be called from a C
  36.               function ONLY. Use ATT() from Clipper.
  37. Found in:     attt.c
  38.  
  39.  
  40. --------------------------------------------------------------------------
  41.  
  42. Function:     Bigelem()
  43. Purpose :     Returns length of longest character element in array
  44. Usage   :     Bigelem(<array>)
  45. Params  :     <array> the array you wish to determine longest element of
  46. Returns :     Length of the longest element
  47. Found in:     bigel.c
  48.  
  49. --------------------------------------------------------------------------
  50.  
  51.  
  52. Function:     Bxx()
  53. Purpose :     Draw a box on the screen with attribute and optional shadow
  54. Usage   :     Bxx(<expN1>, <expN2>, <expN3>, <expN4>, <expN5>, [expN6] )
  55. Params  :     expN1 - top row
  56.               expN2 - left col
  57.               expN3 - bottom row
  58.               expN4 - right column
  59.               expN5 - attribute to box
  60.               expN6 - numeric shadow type  (default 0 - no shadow)
  61.                       follow numeric keypad     |  7 8 9
  62.                                                 |  4 5 6
  63.                                                 |  1 2 3
  64.               expN7 - shadow attribute (default 7 - grey on black)
  65.               expC  - frame string - MUST be 9 characters - default single
  66.  
  67. Returns :     nothing.
  68. Found in:     bxx.c
  69.  
  70. --------------------------------------------------------------------------
  71.  
  72. Function:     Capslock()
  73. Purpose :     sets capslock on
  74. Usage   :     Capslock()
  75. Params  :     nada
  76. Returns :     nada
  77. Found in:     s_caps.c
  78.  
  79. --------------------------------------------------------------------------
  80.  
  81.  
  82. Function:     Capsloff()
  83. Purpose :     sets capslock off
  84. Usage   :     Capsloff()
  85. Params  :     nada
  86. Returns :     nada
  87. Found in:     s_caps.c
  88.  
  89. --------------------------------------------------------------------------
  90. Function:     Cdir()
  91. Purpose :     Change to new directory
  92. Usage   :     Cdir(<expC>)
  93. Params  :     <expC> a valid directory on current drive
  94. Returns :     .t. if succesful, .f. otherwise
  95. Found in:     cdd.asm
  96.  
  97. !seealso:newdrv() curd()
  98.  
  99. --------------------------------------------------------------------------
  100.  
  101.  
  102. Function:     C_grid()
  103. Purpose :     Draws screen in SETCOLORS() function
  104. Usage   :     c_grid(<expN>,<expN>)
  105. Params  :     <expN1-2> Coordinates of top-left corner
  106. Returns :
  107. Found in:     c_grid.c
  108.  
  109.  
  110. --------------------------------------------------------------------------
  111.  
  112.  * INTERNAL *
  113.  
  114. Function:     _gvidm()
  115. Purpose :     Used by Super - C functions to determine video mode
  116. Usage   :     See relevent C functions. To be called from a C
  117.               function ONLY. Use ISCOLOR() from Clipper.
  118. Found in:     gvidm.asm
  119. !seealso:attt()
  120.  
  121. --------------------------------------------------------------------------
  122. Function:     Imbox()
  123. Purpose :     Implodes a screen variable off the screen
  124. Usage   :     Imbox(<expN1..4>,<expC>,<expN5>)
  125. Params  :     expN1..4 - coordinates of the saved screen
  126.               expC     - the saved screen
  127.               expN5    - relative speed of implosion - try 20
  128. Example :     imbox(m->box_top,m->box_left,m->box_bot,m->box_right,m->tbox,20)
  129. Returns :     diddly
  130. Found in:     unbox.c
  131.  
  132. --------------------------------------------------------------------------
  133.  
  134.  
  135. Function:     Prnt()
  136. Purpose :     Write string to row/col with attribute
  137. Usage   :     Prnt(<expN1>, <expN2>, <expC>, <expN3>)
  138. Params  :     expN1 - row
  139.               expN2 - col
  140.               expC  - String to write
  141.               expN3 - color attribute of string
  142. Example :     Prnt(10,10,"Hello, Dolly , yes hello, Dolly",23)
  143. Found in:     prnt.c
  144.  
  145. Returns :     nothing. Does not change cursor location or color setting.
  146.  
  147. --------------------------------------------------------------------------
  148.  
  149. Function:     Takeout()
  150. Purpose :     Extract section of a string between delimiters
  151. Usage   :     Takeout(<expC1>, <expC2>, <expN>)
  152. Params  :     expC1 - string
  153.               expC2 - delimiter  (beginning and end of string are considered
  154.                                   delimiters)
  155.               expN  - occurance
  156.  
  157. Example :     takeout("Next:Previous:First:Quit",":",3)
  158.               returns "First"
  159.  
  160. Returns :     Section of string between delimiters, occurance <expN>.
  161. Found in:     between.c
  162.  
  163.  
  164. --------------------------------------------------------------------------
  165.  
  166. Function:     xBxx()
  167. Purpose :     Draw a box on the screen with attribute and optional shadow
  168. Usage   :     Bxx(<expN1>, <expN2>, <expN3>, <expN4>, <expN5>, <expN6>, ;
  169.                    <expN7>,<expC1>,<expn8>,<expn9>)
  170. Params  :     expN1 - top row
  171.               expN2 - left col
  172.               expN3 - bottom row
  173.               expN4 - right column
  174.               expN5 - attribute of box
  175.               expN6 - numeric shadow type  (default 0 - no shadow)
  176.                       follow numeric keypad     |  7 8 9
  177.                                                 |  4 5 6
  178.                                                 |  1 2 3
  179.               expN7 - shadow attribute (default 7 - grey on black)
  180.               expC  - frame string - MUST be 8 characters - default single
  181.               expN8 - explode speed factor 1-1000 (depends on machine)
  182.  
  183.               All params MUST be passed. For numerics, pass -1 for default.
  184.               For string, pass '' for default.
  185.  
  186. Returns :     nothing.
  187. Found in:     xbxx.c
  188.  
  189. --------------------------------------------------------------------------
  190. Function:     __drive()
  191. Purpose :     Get drive number (0,1,2..)
  192. Usage   :     See S_DRIVE.PRG, which converts the return value to
  193.               a drive letter in the form [D:]
  194. Params  :     none
  195. Returns :     current drive letter (0,1,2..)
  196. Found in:     _drive.asm
  197.  
  198.  
  199.